home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2008 November / PCWNOV08.iso / Software / Freeware / Notepad 5.0.1 / npp.5.0.1.Installer.exe / plugins / doc / FTP_synchonize.ReadMe.txt next >
Encoding:
Text File  |  2007-11-09  |  4.6 KB  |  83 lines
  1. FTP_synchonize:
  2. ---------------
  3. Small plugin for Notepad++ for very basic FTP support.
  4. Currently allows one to connect to a server, browse its contents and upload/download files.
  5.  
  6. Author:
  7. -------
  8. Harry
  9.  
  10. Installation:
  11. -------------
  12. Installation is self explainatory, copy the dll into the plugins folder.
  13.  
  14. Usage:
  15. ------
  16. At first start you have to enable the Folder window, you can do so by selecting the button on the main toolbar
  17. that resembles a small folder (if the toolbar is configured to show plug-in icons), or by selecting the menu-item
  18. under Plugins->FTP_synchronize called "Show FTP Folders". The window should now appear as a dockable dialog.
  19.  
  20. Before you can connect to any server for FTP operations, you have to create a new profile. Select the
  21. "Settings" button from the FTP toolbar (to be found in the Folders window, it resembles a cog). Then, in the
  22. settingswindow, click the "New" button to create a new profile. Change all fields and values to your preferences
  23. and select OK, or Apply if you wish to change other settings.
  24.  
  25. Then you may connect, using the toolbarbutton (small blue plug). A menu will appear and you can select your
  26. profile.
  27. If everything goes right, the statusbar should say "Connected" and a single folder will display in the
  28. folderdialog. Open it by clicking the + next to it and browse for your file.
  29. If you want to open it, rightclick and press 'Download'. The file will now be downloaded to the local cache.
  30. When finished successfully, the file will be opened in Notepad++ for editing. When done, you can reupload the file
  31. using the treeview (rightclick on folder and choose "Upload") or the toolbarbutton (upward pointing arrow).
  32. On success the file should be changed on the server.
  33.  
  34. If you need to refresh the contents of a directory, rightclick on it in the folder window and select 'Refresh'.
  35. Using the appropriate button on the toolbar will function jsut as well.
  36.  
  37. I advise to clear the cache once in a while, the plugin will not do this for you. For every user on every server
  38. once connected a new cache is created.
  39. This cache can be found in the plugins configuration folder of Notepad++, its a folder with the name of the plugin
  40. (normally FTP_synchronize) with a subdirectory called username@server, depending on the username and server when
  41. connected. If you have specified a non-default directory browse there instead.
  42.  
  43. Currently, you can only do one thing at a time, for example, when downloading a file you cannot browse for folders
  44. or upload something else, this may be changed in the future. A quick fix is to copy the dll, this allows you to
  45. connect twice because a 2nd instance is created of the plugin (you will need to reconfigure this, each plugin has
  46. its own configuration file with the same name as the DLL). However, the queue will allow you to queue certain
  47. operation so the plugin will automatically do everything in order when the server is available again.
  48.  
  49. To disconnect from a server, simple click on the button that was previously used to connect.
  50. The icon of the button should change from a connected pair of sockets into a disconnected one.
  51.  
  52. If you wish to display the communications with the FTP server (and some various messages), you can open the
  53. messageswindow by clicking on the corresponding item on the FTP toolbar. This is most usefull for
  54. debugging purposes.
  55. To clear the text, rightclick and select 'Clear' from the popup menu.
  56.  
  57. When an FTP operation is happening, you can abort it by clicking the 'Abort' button on the toolbar.
  58. The operation will fail and the server will be available again for other operations (note that the server can
  59. handle only ONE operation at a time).
  60.  
  61. Some of the cache settings explained:
  62. -------------------------------
  63. Cache file on direct upload:
  64.     If this is set, when you upload a file that has been opened in Notepad++ but is not in the FTPs cache,
  65.     the plugin will copy over the file to the cache
  66.  
  67. Open the cached file automatically (only available if setting above set)
  68.     If this is set, the copied file will be opened in Notepad++ for further editing, the original file will
  69.     remain opened
  70.  
  71. If a file to be uploaded is not a cached file, upload to the last selected directory
  72.     If set, when a file does not reside in the FTPs cache and you attempt to upload that file,
  73.     the file will be uploaded to the last selected directory in the folderview.
  74.  
  75. Upload cached file on save
  76.     If set, when a file opened in Notepad resides in the cache of the current server and that file is being
  77.     saved, it is automatically uploaded to the corresponding FTP folder (aka Autosave)
  78.  
  79.  
  80. Current bugs/limitations:
  81. -------------------------
  82. -One connection
  83. -No resume supported